GetIDFromStorageUnitRef

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODStorageUnit

GetIDFromStorageUnitRef
The GetIDFromStorageUnitRef method returns the storage-unit ID of a referenced storage unit.
ODStorageUnitID GetIDFromStorageUnitRef (
                                 in ODStorageUnitRef aRef);
aRef
A persistent storage-unit reference.
return value
The storage-unit ID of the storage unit referenced by the aRef parameter.

DISCUSSION
Before you call this method, you must focus this storage unit on the value that created the specified persistent reference. This method looks up the storage unit referenced by the specified persistent reference and returns its storage-unit ID.

EXCEPTIONS

kODErrInvalidStorageUnitRef
The specified persistent reference is not valid.
kODErrUnfocusedStorageUnit
This storage unit is not focused on a value.
kODErrZeroRefCount
This storage unit has a reference count of 0.

SEE ALSO
The ODStorageUnitID type (page 903).
The ODStorageUnitRef type (page 903).
The ODStorageUnit::GetID method (page 688).
Listing 2-45 on page 106 in OpenDoc Cookbook.
Listing 2-46 on page 108 in OpenDoc Cookbook.
"Insert" on page 247 in OpenDoc Programmer's Guide.
"Creating Additional Storage Units" on page 301 in OpenDoc Programmer's Guide.
"Clone" on page 323 in OpenDoc Programmer's Guide.